PR Summary

Sci/Tech Reviewer: @thomasmelvin
Code Reviewer:

This adds two new options for the function spaces used by the coordinate fields:

1. The coordinate fields can be in a Wtheta space (discontinuous in the horizontal, continuous in the vertical)
2. The coordinate space used by multigrid meshes is not tied to the coordinate space used by the prime mesh

When Wtheta is used as the function space, the vertical coordinate order is kept as 0, making the coordinates linear in the vertical. These options are an optimisation to the coordinate fields, which will facilitate us moving to coord_order=2 which gives a significant boost in NWP score:

1. using a Wtheta space allows us to have fewer DoFs per cell (see below)
2. keeping a lower coordinate order for multigrid meshes has minimal scientific impact but is a small optimisation, and avoids the bug reported in Halo exchange hangs for high-order W0 field on multigrid mesh in high-res runs #239

Linked to MetOffice/lfric_apps#179

Test branch: the action of the upgrade macro can be seen on my test branch here: https://github.com/tommbendall/lfric_core/pull/2/changes

Code Quality Checklist

• I have performed a self-review of my own code
• My code follows the project's style guidelines
• Comments have been included that aid understanding and enhance the readability of the code
• My changes generate no new warnings
• All automated checks in the CI pipeline have completed successfully

Testing

• I have tested this change locally, using the LFRic Core rose-stem suite
• If required (e.g. API changes) I have also run the LFRic Apps test suite using this branch
• If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
• I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
• Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)

trac.log

Test Suite Results - lfric_core - test_coord_space/run4

Suite Information

Task Information

✅ succeeded tasks - 372

Security Considerations

• I have reviewed my changes for potential security issues
• Sensitive data is properly handled (if applicable)
• Authentication and authorisation are properly implemented (if applicable)

Performance Impact

• Performance of the code has been considered and, if applicable, suitable performance measurements have been conducted

AI Assistance and Attribution

• Some of the content of this change has been produced with the assistance of Generative AI tool name (e.g., Met Office Github Copilot Enterprise, Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the Simulation Systems AI policy (including attribution labels)

Documentation

• Where appropriate I have updated documentation related to this change and confirmed that it builds correctly

PSyclone Approval

• If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the TCD Team

Sci/Tech Review

• I understand this area of code and the changes being added
• The proposed changes correspond to the pull request description
• Documentation is sufficient (do documentation papers need updating)
• Sufficient testing has been completed

(Please alert the code reviewer via a tag when you have approved the SR)

Code Review

• All dependencies have been resolved
• Related Issues have been properly linked and addressed
• CLA compliance has been confirmed
• Code quality standards have been met
• Tests are adequate and have passed
• Documentation is complete and accurate
• Security considerations have been addressed
• Performance impact is acceptable